Class SshServerProcessImpl

All Implemented Interfaces:
IPCObject, Process, SshServerProcess, TelnetServerProcess

public class SshServerProcessImpl extends TelnetServerProcessImpl implements SshServerProcess
Information provided by the PKI file:

    \class SshServerProcess
    
    \brief SshServerProcess handles and manipulates the SSH service.
    
    \example network().getDevice("Router0").getProcess("TelnetServer")
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • setVersion

      public void setVersion(SshVersion version)
      Information provided by the PKI file:
      
          \brief Sets the SSH version.
          
          \param version, the SSH version.
          SSH versions:       shVerDefault = 0,
          sshVerOne = 1,
          sshVerTwo = 2
          
              
      Specified by:
      setVersion in interface SshServerProcess
      Parameters:
      version - Takes in a parameter of version
    • getVersion

      public SshVersion getVersion()
      Information provided by the PKI file:
      
          \brief Returns the SSH version.
          
          \return Ssh::SshVersion,    the SSH version.
          SSH versions:       shVerDefault = 0,
          sshVerOne = 1,
          sshVerTwo = 2
          
              
      Specified by:
      getVersion in interface SshServerProcess
      Returns:
      SshVersion Returns a SshVersion
    • isUsernameReceived

      public boolean isUsernameReceived()
      Information provided by the PKI file:
      
          \brief Returns true if the username is received, otherwise false.
          
          \return bool, true if the username is received, otherwise false.
          
              
      Specified by:
      isUsernameReceived in interface SshServerProcess
      Returns:
      boolean Returns a boolean
    • usernameReceived

      public void usernameReceived(boolean usernameReceived)
      Information provided by the PKI file:
      
          \brief Sets the username as received or not received.
          
          \param usernameReceived, true for received, false for not received.
          
              
      Specified by:
      usernameReceived in interface SshServerProcess
      Parameters:
      usernameReceived - Takes in a parameter of usernameReceived
    • setRetryAmount

      public void setRetryAmount(int amt)
      Information provided by the PKI file:
      
          \brief Sets the retry amount.
          
          \param amt, the retry amount.
          
              
      Specified by:
      setRetryAmount in interface SshServerProcess
      Parameters:
      amt - Takes in a parameter of amt
    • getRetryAmount

      public int getRetryAmount()
      Information provided by the PKI file:
      
          \brief Returns the retry amount.
          
          \return int, the retry amount.
          
              
      Specified by:
      getRetryAmount in interface SshServerProcess
      Returns:
      int Returns a int
    • setAuthTimeout

      public void setAuthTimeout(int sec)
      Information provided by the PKI file:
      
          \brief Sets the authentication timeout.
          
          \param sec, the authentication timeout.
          
              
      Specified by:
      setAuthTimeout in interface SshServerProcess
      Parameters:
      sec - Takes in a parameter of sec
    • getAuthTimeout

      public int getAuthTimeout()
      Information provided by the PKI file:
      
          \brief Returns the authentication timeout.
          
          \param int, the authentication timeout.
          
              
      Specified by:
      getAuthTimeout in interface SshServerProcess
      Returns:
      int Returns a int